<%= project.type %>
===================

[![Gem Version](https://img.shields.io/gem/v/<%= project.file %>.svg?style=flat)][gem]
[![Build Status](https://img.shields.io/travis/<%= user %>/<%= project.file %>/master.svg?style=flat)][travis]
[![Dependency Status](https://img.shields.io/gemnasium/<%= user %>/<%= project.file %>.svg?style=flat)][gemnasium]
[![Code Climate](https://img.shields.io/codeclimate/github/<%= user %>/<%= project.file %>.svg?style=flat)][codeclimate]
[![Coverage](https://img.shields.io/coveralls/<%= user %>/<%= project.file %>.svg?style=flat)][coveralls]
[![Inline docs](http://inch-ci.org/github/<%= user %>/<%= project.file %>.svg)][inch]

[codeclimate]: https://codeclimate.com/github/<%= user %>/<%= project.file %>
[coveralls]: https://coveralls.io/r/<%= user %>/<%= project.file %>
[gem]: https://rubygems.org/gems/<%= project.file %>
[gemnasium]: https://gemnasium.com/<%= user %>/<%= project.file %>
[travis]: https://travis-ci.org/<%= user %>/<%= project.file %>
[inch]: https://inch-ci.org/github/<%= user %>/<%= project.file %>

@todo: describe the module

Synopsis
--------

@todo Describe the base use

Installation
------------

Add this line to your application's Gemfile:

```ruby
# Gemfile
gem "<%= project.file %>"
```

Then execute:

```
bundle
```

Or add it manually:

```
gem install <%= project.file %>
```

Compatibility
-------------

Tested under rubies [compatible to MRI <%= ruby %>+](.travis.yml).

Uses [RSpec] 3.0+ for testing and [hexx-suit] for dev/test tools collection.

[RSpec]: http://rspec.org
[hexx-suit]: https://github.com/nepalez/hexx-suit

Contributing
------------

* Read the [STYLEGUIDE](config/metrics/STYLEGUIDE)
* [Fork the project](https://github.com/<%= user %>/<%= project.file %>)
* Create your feature branch (`git checkout -b my-new-feature`)
* Add tests for it
* Commit your changes (`git commit -am '[UPDATE] Add some feature'`)
* Push to the branch (`git push origin my-new-feature`)
* Create a new Pull Request

License
-------

See the [MIT LICENSE](LICENSE).
